/*
 * Generic graph library
 * Copyright (C) 2004, University of Maryland
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package edu.umd.cs.findbugs.graph;

/**
 * Callback interface for building a search tree from a depth first search.
 */
public interface SearchTreeCallback<VertexType extends GraphVertex<VertexType>> {
    /**
     * Start a search tree.
     *
     * @param vertex
     *            the root of the search tree
     */
    public void startSearchTree(VertexType vertex);

    /**
     * Add an edge to the current search tree.
     *
     * @param parent
     *            the parent vertex
     * @param child
     *            the child vertex
     */
    public void addToSearchTree(VertexType parent, VertexType child);
}
